home *** CD-ROM | disk | FTP | other *** search
/ Aminet 21 / Aminet 21 (1997)(GTI - Schatztruhe)[!][Oct 1997].iso / Aminet / comm / maxs / KFBSpeedup.lha / KFBspeedup.doc < prev    next >
Text File  |  1997-08-07  |  6KB  |  189 lines
  1.  
  2.                             KFB Speedup patches
  3.                             ~~~~~~~~~~~~~~~~~~~
  4.  
  5.                 (C) Colin Wilson  Sysop of Amiga Phoenix BBS
  6.  
  7.     (my phone number is changing soon and I don't know what it is yet !)
  8.  
  9.                    Email : phoenixbbs@cableinet.co.uk
  10.  
  11.  
  12.   Requirements :
  13.   ~~~~~~~~~~~~
  14.  
  15.       Maxs BBS and KFB v1.1
  16.  
  17.  
  18.  
  19.   What it does :
  20.   ~~~~~~~~~~~~
  21.  
  22.       These programs speed up KFB by splitting the large kfb.data file into
  23. smaller files, with one 'new' file per file area, containing only the files
  24. in any one area. Two new doors PER AREA are required, and will be made by
  25. the programs in this archive.
  26.  
  27.       Unfortunately, some alterations to your config will be necessary, and
  28. the patched doors will need to be copied to KFB:  - both a KFBLIST and
  29. KFBDOWNLOAD door will be patched for each section to look for the new small
  30. data file.
  31.  
  32.       This use of a door for each file area also means that the marked files
  33. * MUST * be downloaded within each section, because the reference pointers
  34. held in KFB:users/ will become incorrect for any other area, and will point
  35. to the wrong files (because it will be looking at the wrong data file).
  36.  
  37.       One nice thing is that you can remove this at any time and the original
  38. kfb.data file remains untouched - it's only ever read by the other programs
  39. and NEVER altered.
  40.  
  41.  
  42.   Why ? :
  43.   ~~~~~
  44.  
  45.       It's bloody fast !  - better for very large filebases where the screen
  46. might otherwise be blank for 20 seconds or something while it scans the data
  47. file.
  48.  
  49.  
  50.  
  51.   Limitations :
  52.   ~~~~~~~~~~~
  53.  
  54.       1) A new upload will ONLY appear on a linked list or a new file scan
  55.          (using the original kfblist door) until the data files are updated.
  56.  
  57.       2) Files *MUST* be downloaded from an individual area if they were
  58.          marked in an individual area to save marked file confusion.
  59.  
  60.       3) Unless I wrote a patch for the kfbedit door (ask if you want one)
  61.          the kfbedit door doesn't work properly now unless it's used via
  62.          the linked section (it looks at the kfb.data file, not the small
  63.          fast ones). As before, you'd need one for every file area.
  64.  
  65.          I'd suggest removing it from individual file areas to save hassle !
  66.  
  67.  
  68.       4) Edit or mark files for deletion from the linked section ONLY !!!!
  69.          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  70.  
  71.                                      ^
  72.                                      |
  73.  
  74.                                 Important ;-)
  75.  
  76.  
  77.   To use :
  78.   ~~~~~~
  79.  
  80.        First, run the KFBcreate_data program
  81.  
  82.          (this makes a small reference file in RAM: for the others)
  83.  
  84.        Make a directory in KFB: called 'dat' ie. KFB:DAT/
  85.  
  86.  
  87.        The remaining programs can then be run in any order
  88.  
  89.        The patched doors are made in RAM: and should be copied to KFB:
  90.  
  91.  
  92.        It would be useful to assign a dummy file area FB: to RAM: or
  93.        something just in case something happens like a user changing
  94.        areas with files marked from a previous area.
  95.  
  96.  
  97.                                  ~~~~~~~~~~
  98.  
  99.        For day-to-day upkeep, the only programs you'll need to run are the
  100.        KFBcreate_data and split_kfb_areas.
  101.  
  102.        This can be done daily automatically via a script from fido cfg,
  103.        but neither take more than a minute or so, and can be run from
  104.        workbench whenever the fancy takes you !
  105.  
  106.  
  107.  
  108.   What the programs do :
  109.   ~~~~~~~~~~~~~~~~~~~~
  110.  
  111.             KFBcreate_data
  112.  
  113.                   Makes a small reference file in RAM: - this program
  114.                   remains unchanged from it's original use as a data
  115.                   file creator for use by my filelist generator.
  116.  
  117.                   The information held in this file relates to file
  118.                   areas, and the offset from the start of the file is
  119.                   a pointer to the file data in the KFB.DATA file.
  120.  
  121.             split_kfb_areas
  122.  
  123.                   Does exactly that - using the data file, it will
  124.                   create an individual file for each area, and put it
  125.                   in KFB:DAT/  The filename will be in this format:
  126.                   FBxx where xx is the file area held in that file.
  127.                   A seperate file will be made for every file area.
  128.  
  129.             make_kfbdownload_patches
  130.  
  131.                   Reads the original kfbdownload door, and will alter
  132.                   the search path for it's data file. A seperate new
  133.                   door will be 'created' for every file area.
  134.  
  135.             make_kfblist_patches
  136.  
  137.                   As make_kfbdownload_patches but for the kfblist door
  138.  
  139.  
  140.  
  141.   Changes to your config :
  142.   ~~~~~~~~~~~~~~~~~~~~~~
  143.  
  144.       The linked section FB00 should remain the same, using the original
  145. kfblist and kfbdownload door.
  146.  
  147.       All other areas need to be altered to include the area number after
  148. the door name, ie.
  149.  
  150.    R     34     0     5     10000     KFB:KFBLIST20 R20
  151.  
  152.                                                  ^^
  153.                            that runs the specific door for that section
  154.                            and is the only addition needed :)
  155.  
  156.       You will need to add the area digits to both the forward / reverse /
  157. search options where applicable, and also to the kfbdownload option for
  158. that area, ie.
  159.  
  160.    D     34     0     5     10000     KFB:KFBDOWNLOAD20
  161.  
  162.  
  163.  
  164.  
  165.   Credits & greetz :
  166.   ~~~~~~~~~~~~~~~~
  167.  
  168.     Krion & Accolyte (without whom we wouldn't have KFB!)
  169.     My wife (for not giving the computer a bucket of water despite threats!)
  170.     Spanner
  171.     Protoda
  172.     Rooster
  173.  
  174.            Anyone else using Maxs :)   (ESPECIALLY with KFB !!!!)
  175.  
  176.  
  177.   Bugs :
  178.   ~~~~
  179.  
  180.       None known that weren't already present (although extremely rare) in
  181. the original doors (none witnessed during tests!).
  182.  
  183.       If a user changes areas with marked files, then tries to download from
  184. a different area, it appears that the marked files list is deleted when it
  185. hits a file that's out of 'range' in the user data in KFB:users/
  186.  
  187.     Answer : put a msg on screen to tell them to download from each area,
  188.              and if they STILL can't get it right, it's their problem !
  189.